test: run bun handwritten tests in bun runtime for firestore through pubsub plus spanner-driver by danieljbruce · Pull Request #9452 · googleapis/google-cloud-node

danieljbruce · 2026-09-25T17:45:27Z

Description

Updates handwritten packages across the repository to use the runtime-agnostic test runner (bin/run-test.cjs) and addresses test compatibility issues when running under the Bun runtime:

Migrate test scripts to run-test.cjs: Updated test and system-test scripts in package.json for bigquery, bigquery-storage, datastore, error-reporting, firestore, google-cloud-dns, logging, logging-bunyan, logging-winston, pubsub, and spanner-driver to use node ../../bin/run-test.cjs --config ../../.mocharc.cjs.
handwritten/datastore:
- Added @grpc/grpc-js and @grpc/proto-loader to devDependencies and updated pnpm-lock.yaml to ensure mock server tests resolve gRPC dependencies under pnpm's strict package isolation.
- Accommodated JavaScriptCore / Bun null property error message formatting ("null is not an object (evaluating 'data.name.toString')") alongside existing V8/Node patterns in test/index.ts.
handwritten/bigquery-storage:
- Adjusted proto test data types and timestamp formatting in test/adapt/proto.ts so deepStrictEqual assertions and Prettier formatting pass cleanly across runtimes.
handwritten/error-reporting:
- Sanitized environment variables in unit tests (configuration.ts, service-configuration.ts) to avoid cross-test pollution during non-parallel execution.
handwritten/logging:
- Explicitly initialized instrumentation.setInstrumentationStatus(true) in test/log-sync.ts beforeEach to prevent automatic diagnostic log emission from polluting file stream output during sequential test runs.
handwritten/pubsub:
- Fixed a test deadlock in test/message-queues.ts (ModAckQueue -> should send call options) by capturing the completion promise and flushing the queue before awaiting completion.

Impact

Enables unit and system tests for these handwritten packages to execute successfully under both Node.js and the Bun runtime (bun --bun run test).
Resolves flaky timeouts, environmental variable leakage, and runtime-specific assertion discrepancies across the affected test suites without altering public APIs or production behavior.
Ensures all workspace package dependencies are properly declared and satisfied under strict pnpm package isolation in CI.

Scope

Libraries included: firestore, google-cloud-dns, logging, logging-bunyan, logging-winston, pubsub
Remaining: bigtable, spanner, storage

We also updated the handwritten libraries that are already done so that they use the test-runner with a simpler script without updating gapic tools.

Adds bin/run-test.cjs and bin/proxyquire-bun-shim.cjs to run Mocha tests across both Node.js and Bun without breaking Node coverage or parallelism. When invoked under Node.js, bin/run-test.cjs delegates to c8 and Mocha with worker-thread parallelism enabled. When invoked under Bun (via bun --bun or JS_RUNTIME=bun), it skips c8, disables Mocha worker threads (--no-parallel), preloads the Bun proxyquire compatibility shim, and executes Mocha directly in-process so #!/usr/bin/env node shebangs do not silently switch execution back to Node.js.

…gnal timeout override

…ogging-bunyan, logging-winston, pubsub, spanner, spanner-driver, and storage

…into bun-runtime/1-test-runner-handwritten-libraries # Conflicts: # core/packages/gax/.mocharc.js

This reverts commit 5a29104.

This reverts commit c9446ab.

…porting

…ps://github.com/googleapis/google-cloud-node into bun-runtime/1-test-runner-handwritten-libraries

This reverts commit 4c4a74d.

…ime" This reverts commit 486a301.

…bun runtime"" This reverts commit 687e386.

This reverts commit 756cc45.

…into bun-runtime/1-test-runner-handwritten-libraries-2

…ttps://github.com/googleapis/google-cloud-node into bun-runtime/1-test-runner-handwritten-libraries-2

…th bun tests instead

…gging, logging-bunyan, logging-winston, pubsub, spanner, spanner-driver, and storage" This reverts commit 8088cf4.

…ies-3

danieljbruce · 2026-09-25T18:15:54Z

/gemini review

gemini-code-assist

Code Review

This pull request standardizes test execution across multiple packages by replacing direct mocha and c8 invocations with a centralized test runner script ('run-test.cjs'). It also addresses a deadlock issue in the Pub/Sub tests under Bun by separating the queue addition and flushing operations, and disables automatic diagnostic instrumentation during logging tests. The reviewer suggested simplifying the Pub/Sub test fix by sequentially awaiting the flush and completion promises instead of using Promise.all.

gemini-code-assist · 2026-09-25T18:17:19Z

+      const completion = modAckQueue.add(new FakeMessage() as Message, 10);
+      await Promise.all([completion, modAckQueue.flush('test')]);


Instead of using Promise.all to concurrently await the completion promise and the flush operation, you can sequentially await them. Since add() synchronously queues the message and returns a promise, calling flush() immediately after will trigger the flush and resolve the completion promise. Awaiting them sequentially is simpler, avoids the complexity of Promise.all, and prevents potential unhandled promise rejections if one of them fails.

Suggested change

const completion = modAckQueue.add(new FakeMessage() as Message, 10);

await Promise.all([completion, modAckQueue.flush('test')]);

const completion = modAckQueue.add(new FakeMessage() as Message, 10);

await modAckQueue.flush('test');

await completion;

This is the opposite of what was suggested 2 suggestions ago. I think we can stick with the code as it is.

bshaffer

Can we simplify node ../../bin/run-test.cjs --config ../../.mocharc.cjs build/test to just run-test build/test?

If we expose run-test in bin on a workspace package (e.g. gapic-tools or a package in core/dev-packages) and add it to the root package.json devDependencies, pnpm will link it into the root node_modules/.bin so it is on PATH for all workspace packages.
We can drop --config ../../.mocharc.cjs — Mocha already walks up directories to find the root .mocharc.cjs when no local config exists, and passing --config ../../.mocharc.cjs here overrides the package-local .mocharc.js configs in handwritten/* (like firestore/.mocharc.js).

This reverts commit 55e9e98.

danieljbruce · 2026-09-25T21:18:22Z

Can we simplify node ../../bin/run-test.cjs --config ../../.mocharc.cjs build/test to just run-test build/test?

If we expose run-test in bin on a workspace package (e.g. gapic-tools or a package in core/dev-packages) and add it to the root package.json devDependencies, pnpm will link it into the root node_modules/.bin so it is on PATH for all workspace packages.

We can drop --config ../../.mocharc.cjs — Mocha already walks up directories to find the root .mocharc.cjs when no local config exists, and passing --config ../../.mocharc.cjs here overrides the package-local .mocharc.js configs in handwritten/* (like firestore/.mocharc.js).

Yeah. I looked into this and the windows tests seem to have trouble with .. which can be addressed by prepending with node, but I did what you said and added a link to tools for all workspace packages.

danieljbruce · 2026-09-25T21:31:09Z

Can we simplify node ../../bin/run-test.cjs --config ../../.mocharc.cjs build/test to just run-test build/test?

If we expose run-test in bin on a workspace package (e.g. gapic-tools or a package in core/dev-packages) and add it to the root package.json devDependencies, pnpm will link it into the root node_modules/.bin so it is on PATH for all workspace packages.

We can drop --config ../../.mocharc.cjs — Mocha already walks up directories to find the root .mocharc.cjs when no local config exists, and passing --config ../../.mocharc.cjs here overrides the package-local .mocharc.js configs in handwritten/* (like firestore/.mocharc.js).

Yeah. I looked into this and the windows tests seem to have trouble with .. which can be addressed by prepending with node, but I did what you said and added a link to tools for all workspace packages.

Actually, I suggest we do #2, but not #1.

Adding a link to the gapic-tools directory doesn't work because it makes the system tests fail. GCB does not include the gapic-tools directory unless you add it to devDependencies which isn't worth it for a minor simplification.

…evert gapic-tools changes

bshaffer · 2026-09-28T18:12:59Z

Adding a link to the gapic-tools directory doesn't work because it makes the system tests fail. GCB does not include the gapic-tools directory

Agreed, SGTM

quirogas and others added 30 commits September 21, 2026 21:26

fix(tools): compare Headers entries in deepEqual and document AbortSi…

27579a0

…gnal timeout override

Modify all the handwritten libraries to use the new test runner

93ae259

Change the literal values so that deep equal passes for bun

dc9e502

Revert test runner changes in firestore, google-cloud-dns, logging, l…

8088cf4

…ogging-bunyan, logging-winston, pubsub, spanner, spanner-driver, and storage

Merge branch 'main' of https://github.com/googleapis/google-cloud-node …

d208619

…into bun-runtime/1-test-runner-handwritten-libraries # Conflicts: # core/packages/gax/.mocharc.js

revert the bigtable changes

756cc45

feat(tools): add --exit flag to test runner under bun runtime

5a29104

Add the stub for cloud-profiler

e780546

Revert "feat(tools): add --exit flag to test runner under bun runtime"

c9446ab

This reverts commit 5a29104.

Reapply "feat(tools): add --exit flag to test runner under bun runtime"

845f8d7

This reverts commit c9446ab.

Revert changes in bigquery, bigquery-storage, datastore, and error-re…

4f67497

…porting

Merge branch 'main' into bun-runtime/1-test-runner-handwritten-libraries

6668550

test: fix tests for cloud-profiler library with the bun runtime

4c4a74d

Merge branch 'bun-runtime/1-test-runner-handwritten-libraries' of htt…

895f088

…ps://github.com/googleapis/google-cloud-node into bun-runtime/1-test-runner-handwritten-libraries

Revert "test: fix tests for cloud-profiler library with the bun runtime"

486a301

This reverts commit 4c4a74d.

Reapply "test: fix tests for cloud-profiler library with the bun runt…

687e386

…ime" This reverts commit 486a301.

Revert "Reapply "test: fix tests for cloud-profiler library with the …

1f30b9d

…bun runtime"" This reverts commit 687e386.

Revert "revert the bigtable changes"

da1602a

This reverts commit 756cc45.

Resolve compiler errors with datastore test

b6e6db1

sterilize the environment variables

3a88414

Merge branch 'main' of https://github.com/googleapis/google-cloud-node …

8dee1fc

…into bun-runtime/1-test-runner-handwritten-libraries-2

test: update first half of handwritten libraries to be bun compatible

7534a50

Merge branch 'bun-runtime/1-test-runner-handwritten-libraries-2' of h…

f064618

…ttps://github.com/googleapis/google-cloud-node into bun-runtime/1-test-runner-handwritten-libraries-2

Revert source code changes. We can achieve what we need to achieve wi…

90d9b6e

…th bun tests instead

revert bigtable related changes

fa014d2

Add helpful devDependencies to resolve unit test error.

ec5195e

Add grpc-js to dev dependencies

db68151

Fix the linting error with proto.ts

da9b310

Revert "Revert test runner changes in firestore, google-cloud-dns, lo…

eeb2881

…gging, logging-bunyan, logging-winston, pubsub, spanner, spanner-driver, and storage" This reverts commit 8088cf4.

danieljbruce and others added 2 commits September 25, 2026 14:09

Improve cleanup task

b03058e

Merge branch 'main' into bun-runtime/1-test-runner-handwritten-librar…

fdc7270

…ies-3

gemini-code-assist Bot reviewed Sep 25, 2026

View reviewed changes

danieljbruce marked this pull request as ready for review September 25, 2026 18:21

danieljbruce requested review from a team as code owners September 25, 2026 18:21

github-actions Bot requested a review from shivanee-p September 25, 2026 18:21

bshaffer reviewed Sep 25, 2026

View reviewed changes

danieljbruce added 3 commits September 25, 2026 15:26

Use the test runner for spanner, storage and bigtable

5cecab2

Adjust all the package.json files

2a8a2d8

revert spanner, bigtable and storage changes

d8bdff9

danieljbruce requested review from a team as code owners September 25, 2026 19:29

danieljbruce added 7 commits September 25, 2026 15:52

just run run-test directly

53cf89f

Add run-test to gapic tools

8233cbf

eliminate the tools directory changes

55e9e98

remove the no-parallel flags from the system test scripts

5f9de1c

remove —no-parallel

c8c4d71

remove core/packages/tools/bin/run-test.js

71bfe1c

Revert "eliminate the tools directory changes"

a61d3b3

This reverts commit 55e9e98.

danieljbruce added 2 commits September 28, 2026 09:53

test: invoke bin/run-test.cjs directly in handwritten libraries and r…

4ca083a

…evert gapic-tools changes

chore: merge origin/main into branch

c01c944

quirogas approved these changes Sep 28, 2026

View reviewed changes

danieljbruce merged commit eb4cf9e into main Sep 28, 2026
50 checks passed

danieljbruce deleted the bun-runtime/1-test-runner-handwritten-libraries-3 branch September 28, 2026 18:57

Navigation Menu

test: run bun handwritten tests in bun runtime for firestore through pubsub plus spanner-driver - #9452

test: run bun handwritten tests in bun runtime for firestore through pubsub plus spanner-driver#9452
danieljbruce merged 54 commits into
mainfrom
bun-runtime/1-test-runner-handwritten-libraries-3

danieljbruce commented Sep 25, 2026 •

edited

Loading

Uh oh!

danieljbruce commented Sep 25, 2026

Uh oh!

gemini-code-assist Bot left a comment

Uh oh!

gemini-code-assist Bot Sep 25, 2026

Uh oh!

danieljbruce Sep 25, 2026

Uh oh!

bshaffer left a comment

Uh oh!

danieljbruce commented Sep 25, 2026

Uh oh!

danieljbruce commented Sep 25, 2026 •

edited

Loading

Uh oh!

bshaffer commented Sep 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		const completion = modAckQueue.add(new FakeMessage() as Message, 10);
		await Promise.all([completion, modAckQueue.flush('test')]);

Conversation

danieljbruce commented Sep 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Impact

Scope

Uh oh!

danieljbruce commented Sep 25, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

danieljbruce Sep 25, 2026

Choose a reason for hiding this comment

Uh oh!

bshaffer left a comment

Choose a reason for hiding this comment

Uh oh!

danieljbruce commented Sep 25, 2026

Uh oh!

danieljbruce commented Sep 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bshaffer commented Sep 28, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

danieljbruce commented Sep 25, 2026 •

edited

Loading

danieljbruce commented Sep 25, 2026 •

edited

Loading